Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add versioned docs to build-docs task #7413

Merged
merged 3 commits into from
Sep 30, 2020
Merged

Conversation

clevinson
Copy link
Contributor

@clevinson clevinson commented Sep 30, 2020

Description

Although the Makefile currently has support for building multiple versions of the SDK docs, it sets the path for each version of the site to the corresponding branch name.

This PR enables the version's path prefix to be set independently of the branch name, and adds v0.39 to be compiled from the launchpad/backports branch in addition to master docs.

The default docs site (accessible via the root at docs.cosmos.network) will be the last entry in the ./docs/versions file.

Note: This should not get merged until after #7412 is merged, as launchpad docs currently fail to compile

closes: #6308
ref: #6953


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
Copy link
Contributor

@fadeev fadeev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can confirm that this builds two docs websites in separate directories: master and v0.39 👍

@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Sep 30, 2020
@mergify mergify bot merged commit a2c6745 into master Sep 30, 2020
@mergify mergify bot deleted the clevinson/build-versioned-docs branch September 30, 2020 16:12
@clevinson
Copy link
Contributor Author

This task fails due to comments not being handled properly in make tasks, fix here: #7420

@lovincyrus
Copy link
Contributor

After merging #7420master, I noticed that CI is still failing at the sync-docs step due to the fact it can't locate the aws credentials. Ping-ed @helder-moreira to have a look at this.

I've just merged masterdocs-staging as well, it appears to have the same error (unable to locate aws credentials).

@helder-moreira
Copy link
Contributor

@lovincyrus should be fixed in #7444

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: deploy multiple versions
6 participants